package org.dromara.common.log.annotation;

import org.dromara.common.log.enums.BusinessType;
import org.dromara.common.log.enums.OperatorType;

import java.lang.annotation.*;


/**
 * @Author 刘武贵
 * @Date 2024/8/15 22:00
 * @Description 功能描述：自定义操作日志记录注解
 */
// 定义了注解的适用范围，该注解可以用于参数和方法上
@Target({ElementType.PARAMETER, ElementType.METHOD})
// 指定注解的保留策略，该注解在运行时仍然有效
@Retention(RetentionPolicy.RUNTIME)
// 指定该注解可以被文档工具所记录
@Documented
public @interface Log {

    /**
     * 模块
     */
    String title() default "";

    /**
     * 功能
     */
    BusinessType businessType() default BusinessType.OTHER;

    /**
     * 操作人类别
     */
    OperatorType operatorType() default OperatorType.MANAGE;

    /**
     * 是否保存请求的参数
     */
    boolean isSaveRequestData() default true;

    /**
     * 是否保存响应的参数
     */
    boolean isSaveResponseData() default true;


    /**
     * 排除指定的请求参数
     */
    String[] excludeParamNames() default {};

}
